Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

intro changes for smooth migration zeebe user tasks next #4723

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

christinaausley
Copy link
Contributor

@christinaausley christinaausley commented Dec 6, 2024

Description

Resolves remaining changes for https://github.com/camunda/product-hub/issues/2126/.

Note a few open questions below, but the overall goal:

- Should the references in the docs be "Camunda user tasks" or "Job worker-based user tasks managed by Camunda"? The latter is rather wordy, but maybe we can figure out a solution. Regardless, this should only be for the 8.7 docs, yes? Should they still be called "Zeebe user tasks" in 8.6 and 8.5?

Additionally, I am planning to make the following changes:

For 8.6

  • Document that user tasks with Job worker implementation are deprecated (but supported).
  • Explicitly state in migration guide why it is recommended to design a process with one implementation type.

For 8.7

  • Note that the Tasklist API will no longer be supported with 8.9 and recommend migrating. Do we need to mark this as deprecated, or rather just note that it is going to be removed but is still supported?
  • Remove interactive questionnaire in migration guide
  • Rename Zeebe user task to Camunda user task and note terminology change with admonition as the XML may still show Zeebe user task.
  • Document that the C8 REST API only supports user tasks with the Camunda user task implementation.
  • Document that embedded forms are supported only for Job worker-based user tasks. Is this only for next or also should be backported?
    E.g. this section needs to be updated: https://docs.camunda.io/docs/next/components/modeler/web-modeler/advanced-modeling/form-linking/#camunda-form-embedded

A majority of changes for 8.5 and 8.6 have been launched via PR here, though I plan to launch a separate PR for the changes above.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

Copy link
Contributor

github-actions bot commented Dec 6, 2024

👋 🤖 🤔 Hello, @volodymyr-melnykc! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md
  • docs/apis-tools/frontend-development/01-task-applications/02-user-task-lifecycle.md
  • docs/apis-tools/frontend-development/01-task-applications/03-task-application-architecture.md
  • docs/apis-tools/java-client/zeebe-process-test.md
  • docs/apis-tools/migration-manuals/migrate-to-zeebe-user-tasks.md
  • docs/apis-tools/tasklist-api-rest/assets/img/camunda-user-task-selection.png
  • docs/apis-tools/tasklist-api-rest/assets/img/zeebe-user-task-selection.png
  • docs/apis-tools/tasklist-api-rest/specifications/search-tasks.api.mdx
  • docs/components/modeler/bpmn/user-tasks/user-tasks.md
  • docs/components/modeler/web-modeler/advanced-modeling/form-linking.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@christinaausley christinaausley added the 8.7.0-alpha3 January 2024 alpha release label Dec 6, 2024
@volodymyr-melnykc
Copy link
Contributor

  • Should the references in the docs be "Camunda user tasks" or "Job worker-based user tasks managed by Camunda"? The latter is rather wordy, but maybe we can figure out a solution. Regardless, this should only be for the 8.7 docs, yes? Should they still be called "Zeebe user tasks" in 8.6 and 8.5?

@christinaausley In the documentation we should describe how to migrate from Job worker-based user tasks to Camunda user tasks. We can cover it on the page https://docs.camunda.io/docs/next/apis-tools/migration-manuals/migrate-to-zeebe-user-tasks/.

Job worker-based user tasks are deprecated by Camunda with the 8.6 release, but they will continue to be supported to accommodate custom use cases. Either @aleksander-dytko or I can help document this.

  • It is to be covered in the 8.7 docs and backported for 8.6.

Regarding the renaming of "Zeebe user tasks" to "Camunda user tasks," we should document the renaming in the 8.7 docs. In the 8.5 and 8.6 docs they can still be called "Zeebe user tasks" (as this is the term that was initially communicated to customers).

@christinaausley
Copy link
Contributor Author

@volodymyr-melnykc I will have a thorough look through this and make any of the additional adjustments in the PR description by the end of this week 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.7.0-alpha3 January 2024 alpha release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants